3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 use Liuggio\StatsdClient\Sender\SocketSender
;
28 use MediaWiki\Logger\LoggerFactory
;
30 // Hide compatibility functions from Doxygen
34 * Compatibility functions
36 * We support PHP 5.3.3 and up.
37 * Re-implementations of newer functions or functions in non-standard
38 * PHP extensions may be included here.
41 if ( !function_exists( 'mb_substr' ) ) {
44 * @see Fallback::mb_substr
47 function mb_substr( $str, $start, $count = 'end' ) {
48 return Fallback
::mb_substr( $str, $start, $count );
53 * @see Fallback::mb_substr_split_unicode
56 function mb_substr_split_unicode( $str, $splitPos ) {
57 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
61 if ( !function_exists( 'mb_strlen' ) ) {
64 * @see Fallback::mb_strlen
67 function mb_strlen( $str, $enc = '' ) {
68 return Fallback
::mb_strlen( $str, $enc );
72 if ( !function_exists( 'mb_strpos' ) ) {
75 * @see Fallback::mb_strpos
78 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
79 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
83 if ( !function_exists( 'mb_strrpos' ) ) {
86 * @see Fallback::mb_strrpos
89 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
90 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
94 // gzdecode function only exists in PHP >= 5.4.0
95 // http://php.net/gzdecode
96 if ( !function_exists( 'gzdecode' ) ) {
102 function gzdecode( $data ) {
103 return gzinflate( substr( $data, 10, -8 ) );
107 // hash_equals function only exists in PHP >= 5.6.0
108 // http://php.net/hash_equals
109 if ( !function_exists( 'hash_equals' ) ) {
111 * Check whether a user-provided string is equal to a fixed-length secret string
112 * without revealing bytes of the secret string through timing differences.
114 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
115 * function in C) is to compare corresponding bytes and stop at the first difference,
116 * which would take longer for a partial match than for a complete mismatch. This
117 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
118 * and the other may come from an attacker. Statistical analysis of timing measurements
119 * over many requests may allow the attacker to guess the string's bytes one at a time
120 * (and check his guesses) even if the timing differences are extremely small.
122 * When making such a security-sensitive comparison, it is essential that the sequence
123 * in which instructions are executed and memory locations are accessed not depend on
124 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
125 * the inevitable leakage of the string's length. That is generally known anyway as
126 * a chararacteristic of the hash function used to compute the secret value.
128 * Longer explanation: http://www.emerose.com/timing-attacks-explained
130 * @codeCoverageIgnore
131 * @param string $known_string Fixed-length secret string to compare against
132 * @param string $user_string User-provided string
133 * @return bool True if the strings are the same, false otherwise
135 function hash_equals( $known_string, $user_string ) {
136 // Strict type checking as in PHP's native implementation
137 if ( !is_string( $known_string ) ) {
138 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
139 gettype( $known_string ) . ' given', E_USER_WARNING
);
144 if ( !is_string( $user_string ) ) {
145 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
146 gettype( $user_string ) . ' given', E_USER_WARNING
);
151 $known_string_len = strlen( $known_string );
152 if ( $known_string_len !== strlen( $user_string ) ) {
157 for ( $i = 0; $i < $known_string_len; $i++
) {
158 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
161 return ( $result === 0 );
169 * This queues an extension to be loaded through
170 * the ExtensionRegistry system.
172 * @param string $ext Name of the extension to load
173 * @param string|null $path Absolute path of where to find the extension.json file
176 function wfLoadExtension( $ext, $path = null ) {
178 global $wgExtensionDirectory;
179 $path = "$wgExtensionDirectory/$ext/extension.json";
181 ExtensionRegistry
::getInstance()->queue( $path );
185 * Load multiple extensions at once
187 * Same as wfLoadExtension, but more efficient if you
188 * are loading multiple extensions.
190 * If you want to specify custom paths, you should interact with
191 * ExtensionRegistry directly.
193 * @see wfLoadExtension
194 * @param string[] $exts Array of extension names to load
197 function wfLoadExtensions( array $exts ) {
198 global $wgExtensionDirectory;
199 $registry = ExtensionRegistry
::getInstance();
200 foreach ( $exts as $ext ) {
201 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
208 * @see wfLoadExtension
209 * @param string $skin Name of the extension to load
210 * @param string|null $path Absolute path of where to find the skin.json file
213 function wfLoadSkin( $skin, $path = null ) {
215 global $wgStyleDirectory;
216 $path = "$wgStyleDirectory/$skin/skin.json";
218 ExtensionRegistry
::getInstance()->queue( $path );
222 * Load multiple skins at once
224 * @see wfLoadExtensions
225 * @param string[] $skins Array of extension names to load
228 function wfLoadSkins( array $skins ) {
229 global $wgStyleDirectory;
230 $registry = ExtensionRegistry
::getInstance();
231 foreach ( $skins as $skin ) {
232 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
237 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
242 function wfArrayDiff2( $a, $b ) {
243 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
247 * @param array|string $a
248 * @param array|string $b
251 function wfArrayDiff2_cmp( $a, $b ) {
252 if ( is_string( $a ) && is_string( $b ) ) {
253 return strcmp( $a, $b );
254 } elseif ( count( $a ) !== count( $b ) ) {
255 return count( $a ) < count( $b ) ?
-1 : 1;
259 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
260 $cmp = strcmp( $valueA, $valueB );
270 * Appends to second array if $value differs from that in $default
272 * @param string|int $key
273 * @param mixed $value
274 * @param mixed $default
275 * @param array $changed Array to alter
276 * @throws MWException
278 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
279 if ( is_null( $changed ) ) {
280 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
282 if ( $default[$key] !== $value ) {
283 $changed[$key] = $value;
288 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
290 * wfMergeErrorArrays(
291 * array( array( 'x' ) ),
292 * array( array( 'x', '2' ) ),
293 * array( array( 'x' ) ),
294 * array( array( 'y' ) )
303 * @param array $array1,...
306 function wfMergeErrorArrays( /*...*/ ) {
307 $args = func_get_args();
309 foreach ( $args as $errors ) {
310 foreach ( $errors as $params ) {
311 $originalParams = $params;
312 if ( $params[0] instanceof MessageSpecifier
) {
314 $params = array_merge( array( $msg->getKey() ), $msg->getParams() );
316 # @todo FIXME: Sometimes get nested arrays for $params,
317 # which leads to E_NOTICEs
318 $spec = implode( "\t", $params );
319 $out[$spec] = $originalParams;
322 return array_values( $out );
326 * Insert array into another array after the specified *KEY*
328 * @param array $array The array.
329 * @param array $insert The array to insert.
330 * @param mixed $after The key to insert after
333 function wfArrayInsertAfter( array $array, array $insert, $after ) {
334 // Find the offset of the element to insert after.
335 $keys = array_keys( $array );
336 $offsetByKey = array_flip( $keys );
338 $offset = $offsetByKey[$after];
340 // Insert at the specified offset
341 $before = array_slice( $array, 0, $offset +
1, true );
342 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
344 $output = $before +
$insert +
$after;
350 * Recursively converts the parameter (an object) to an array with the same data
352 * @param object|array $objOrArray
353 * @param bool $recursive
356 function wfObjectToArray( $objOrArray, $recursive = true ) {
358 if ( is_object( $objOrArray ) ) {
359 $objOrArray = get_object_vars( $objOrArray );
361 foreach ( $objOrArray as $key => $value ) {
362 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
363 $value = wfObjectToArray( $value );
366 $array[$key] = $value;
373 * Get a random decimal value between 0 and 1, in a way
374 * not likely to give duplicate values for any realistic
375 * number of articles.
377 * @note This is designed for use in relation to Special:RandomPage
378 * and the page_random database field.
382 function wfRandom() {
383 // The maximum random value is "only" 2^31-1, so get two random
384 // values to reduce the chance of dupes
385 $max = mt_getrandmax() +
1;
386 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
391 * Get a random string containing a number of pseudo-random hex characters.
393 * @note This is not secure, if you are trying to generate some sort
394 * of token please use MWCryptRand instead.
396 * @param int $length The length of the string to generate
400 function wfRandomString( $length = 32 ) {
402 for ( $n = 0; $n < $length; $n +
= 7 ) {
403 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
405 return substr( $str, 0, $length );
409 * We want some things to be included as literal characters in our title URLs
410 * for prettiness, which urlencode encodes by default. According to RFC 1738,
411 * all of the following should be safe:
415 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
416 * character which should not be encoded. More importantly, google chrome
417 * always converts %7E back to ~, and converting it in this function can
418 * cause a redirect loop (T105265).
420 * But + is not safe because it's used to indicate a space; &= are only safe in
421 * paths and not in queries (and we don't distinguish here); ' seems kind of
422 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
423 * is reserved, we don't care. So the list we unescape is:
427 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
428 * so no fancy : for IIS7.
430 * %2F in the page titles seems to fatally break for some reason.
435 function wfUrlencode( $s ) {
438 if ( is_null( $s ) ) {
443 if ( is_null( $needle ) ) {
444 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' );
445 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
446 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
452 $s = urlencode( $s );
455 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ),
463 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
464 * "days=7&limit=100". Options in the first array override options in the second.
465 * Options set to null or false will not be output.
467 * @param array $array1 ( String|Array )
468 * @param array|null $array2 ( String|Array )
469 * @param string $prefix
472 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
473 if ( !is_null( $array2 ) ) {
474 $array1 = $array1 +
$array2;
478 foreach ( $array1 as $key => $value ) {
479 if ( !is_null( $value ) && $value !== false ) {
483 if ( $prefix !== '' ) {
484 $key = $prefix . "[$key]";
486 if ( is_array( $value ) ) {
488 foreach ( $value as $k => $v ) {
489 $cgi .= $firstTime ?
'' : '&';
490 if ( is_array( $v ) ) {
491 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
493 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
498 if ( is_object( $value ) ) {
499 $value = $value->__toString();
501 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
509 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
510 * its argument and returns the same string in array form. This allows compatibility
511 * with legacy functions that accept raw query strings instead of nice
512 * arrays. Of course, keys and values are urldecode()d.
514 * @param string $query Query string
515 * @return string[] Array version of input
517 function wfCgiToArray( $query ) {
518 if ( isset( $query[0] ) && $query[0] == '?' ) {
519 $query = substr( $query, 1 );
521 $bits = explode( '&', $query );
523 foreach ( $bits as $bit ) {
527 if ( strpos( $bit, '=' ) === false ) {
528 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
532 list( $key, $value ) = explode( '=', $bit );
534 $key = urldecode( $key );
535 $value = urldecode( $value );
536 if ( strpos( $key, '[' ) !== false ) {
537 $keys = array_reverse( explode( '[', $key ) );
538 $key = array_pop( $keys );
540 foreach ( $keys as $k ) {
541 $k = substr( $k, 0, -1 );
542 $temp = array( $k => $temp );
544 if ( isset( $ret[$key] ) ) {
545 $ret[$key] = array_merge( $ret[$key], $temp );
557 * Append a query string to an existing URL, which may or may not already
558 * have query string parameters already. If so, they will be combined.
561 * @param string|string[] $query String or associative array
564 function wfAppendQuery( $url, $query ) {
565 if ( is_array( $query ) ) {
566 $query = wfArrayToCgi( $query );
568 if ( $query != '' ) {
569 if ( false === strpos( $url, '?' ) ) {
580 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
583 * The meaning of the PROTO_* constants is as follows:
584 * PROTO_HTTP: Output a URL starting with http://
585 * PROTO_HTTPS: Output a URL starting with https://
586 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
587 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
588 * on which protocol was used for the current incoming request
589 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
590 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
591 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
593 * @todo this won't work with current-path-relative URLs
594 * like "subdir/foo.html", etc.
596 * @param string $url Either fully-qualified or a local path + query
597 * @param string $defaultProto One of the PROTO_* constants. Determines the
598 * protocol to use if $url or $wgServer is protocol-relative
599 * @return string Fully-qualified URL, current-path-relative URL or false if
600 * no valid URL can be constructed
602 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
603 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
605 if ( $defaultProto === PROTO_CANONICAL
) {
606 $serverUrl = $wgCanonicalServer;
607 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
608 // Make $wgInternalServer fall back to $wgServer if not set
609 $serverUrl = $wgInternalServer;
611 $serverUrl = $wgServer;
612 if ( $defaultProto === PROTO_CURRENT
) {
613 $defaultProto = $wgRequest->getProtocol() . '://';
617 // Analyze $serverUrl to obtain its protocol
618 $bits = wfParseUrl( $serverUrl );
619 $serverHasProto = $bits && $bits['scheme'] != '';
621 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
622 if ( $serverHasProto ) {
623 $defaultProto = $bits['scheme'] . '://';
625 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
626 // This really isn't supposed to happen. Fall back to HTTP in this
628 $defaultProto = PROTO_HTTP
;
632 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
634 if ( substr( $url, 0, 2 ) == '//' ) {
635 $url = $defaultProtoWithoutSlashes . $url;
636 } elseif ( substr( $url, 0, 1 ) == '/' ) {
637 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
638 // otherwise leave it alone.
639 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
642 $bits = wfParseUrl( $url );
644 // ensure proper port for HTTPS arrives in URL
645 // https://phabricator.wikimedia.org/T67184
646 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
647 $bits['port'] = $wgHttpsPort;
650 if ( $bits && isset( $bits['path'] ) ) {
651 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
652 return wfAssembleUrl( $bits );
656 } elseif ( substr( $url, 0, 1 ) != '/' ) {
657 # URL is a relative path
658 return wfRemoveDotSegments( $url );
661 # Expanded URL is not valid.
666 * This function will reassemble a URL parsed with wfParseURL. This is useful
667 * if you need to edit part of a URL and put it back together.
669 * This is the basic structure used (brackets contain keys for $urlParts):
670 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
672 * @todo Need to integrate this into wfExpandUrl (bug 32168)
675 * @param array $urlParts URL parts, as output from wfParseUrl
676 * @return string URL assembled from its component parts
678 function wfAssembleUrl( $urlParts ) {
681 if ( isset( $urlParts['delimiter'] ) ) {
682 if ( isset( $urlParts['scheme'] ) ) {
683 $result .= $urlParts['scheme'];
686 $result .= $urlParts['delimiter'];
689 if ( isset( $urlParts['host'] ) ) {
690 if ( isset( $urlParts['user'] ) ) {
691 $result .= $urlParts['user'];
692 if ( isset( $urlParts['pass'] ) ) {
693 $result .= ':' . $urlParts['pass'];
698 $result .= $urlParts['host'];
700 if ( isset( $urlParts['port'] ) ) {
701 $result .= ':' . $urlParts['port'];
705 if ( isset( $urlParts['path'] ) ) {
706 $result .= $urlParts['path'];
709 if ( isset( $urlParts['query'] ) ) {
710 $result .= '?' . $urlParts['query'];
713 if ( isset( $urlParts['fragment'] ) ) {
714 $result .= '#' . $urlParts['fragment'];
721 * Remove all dot-segments in the provided URL path. For example,
722 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
723 * RFC3986 section 5.2.4.
725 * @todo Need to integrate this into wfExpandUrl (bug 32168)
727 * @param string $urlPath URL path, potentially containing dot-segments
728 * @return string URL path with all dot-segments removed
730 function wfRemoveDotSegments( $urlPath ) {
733 $inputLength = strlen( $urlPath );
735 while ( $inputOffset < $inputLength ) {
736 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
737 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
738 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
739 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
742 if ( $prefixLengthTwo == './' ) {
743 # Step A, remove leading "./"
745 } elseif ( $prefixLengthThree == '../' ) {
746 # Step A, remove leading "../"
748 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
749 # Step B, replace leading "/.$" with "/"
751 $urlPath[$inputOffset] = '/';
752 } elseif ( $prefixLengthThree == '/./' ) {
753 # Step B, replace leading "/./" with "/"
755 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
756 # Step C, replace leading "/..$" with "/" and
757 # remove last path component in output
759 $urlPath[$inputOffset] = '/';
761 } elseif ( $prefixLengthFour == '/../' ) {
762 # Step C, replace leading "/../" with "/" and
763 # remove last path component in output
766 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
767 # Step D, remove "^.$"
769 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
770 # Step D, remove "^..$"
773 # Step E, move leading path segment to output
774 if ( $prefixLengthOne == '/' ) {
775 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
777 $slashPos = strpos( $urlPath, '/', $inputOffset );
779 if ( $slashPos === false ) {
780 $output .= substr( $urlPath, $inputOffset );
781 $inputOffset = $inputLength;
783 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
784 $inputOffset +
= $slashPos - $inputOffset;
789 $slashPos = strrpos( $output, '/' );
790 if ( $slashPos === false ) {
793 $output = substr( $output, 0, $slashPos );
802 * Returns a regular expression of url protocols
804 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
805 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
808 function wfUrlProtocols( $includeProtocolRelative = true ) {
809 global $wgUrlProtocols;
811 // Cache return values separately based on $includeProtocolRelative
812 static $withProtRel = null, $withoutProtRel = null;
813 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
814 if ( !is_null( $cachedValue ) ) {
818 // Support old-style $wgUrlProtocols strings, for backwards compatibility
819 // with LocalSettings files from 1.5
820 if ( is_array( $wgUrlProtocols ) ) {
821 $protocols = array();
822 foreach ( $wgUrlProtocols as $protocol ) {
823 // Filter out '//' if !$includeProtocolRelative
824 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
825 $protocols[] = preg_quote( $protocol, '/' );
829 $retval = implode( '|', $protocols );
831 // Ignore $includeProtocolRelative in this case
832 // This case exists for pre-1.6 compatibility, and we can safely assume
833 // that '//' won't appear in a pre-1.6 config because protocol-relative
834 // URLs weren't supported until 1.18
835 $retval = $wgUrlProtocols;
838 // Cache return value
839 if ( $includeProtocolRelative ) {
840 $withProtRel = $retval;
842 $withoutProtRel = $retval;
848 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
849 * you need a regex that matches all URL protocols but does not match protocol-
853 function wfUrlProtocolsWithoutProtRel() {
854 return wfUrlProtocols( false );
858 * parse_url() work-alike, but non-broken. Differences:
860 * 1) Does not raise warnings on bad URLs (just returns false).
861 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
862 * protocol-relative URLs) correctly.
863 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
865 * @param string $url A URL to parse
866 * @return string[] Bits of the URL in an associative array, per PHP docs
868 function wfParseUrl( $url ) {
869 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
871 // Protocol-relative URLs are handled really badly by parse_url(). It's so
872 // bad that the easiest way to handle them is to just prepend 'http:' and
873 // strip the protocol out later.
874 $wasRelative = substr( $url, 0, 2 ) == '//';
875 if ( $wasRelative ) {
878 MediaWiki\
suppressWarnings();
879 $bits = parse_url( $url );
880 MediaWiki\restoreWarnings
();
881 // parse_url() returns an array without scheme for some invalid URLs, e.g.
882 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
883 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
887 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
888 $bits['scheme'] = strtolower( $bits['scheme'] );
890 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
891 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
892 $bits['delimiter'] = '://';
893 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
894 $bits['delimiter'] = ':';
895 // parse_url detects for news: and mailto: the host part of an url as path
896 // We have to correct this wrong detection
897 if ( isset( $bits['path'] ) ) {
898 $bits['host'] = $bits['path'];
905 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
906 if ( !isset( $bits['host'] ) ) {
910 if ( isset( $bits['path'] ) ) {
911 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
912 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
913 $bits['path'] = '/' . $bits['path'];
920 // If the URL was protocol-relative, fix scheme and delimiter
921 if ( $wasRelative ) {
922 $bits['scheme'] = '';
923 $bits['delimiter'] = '//';
929 * Take a URL, make sure it's expanded to fully qualified, and replace any
930 * encoded non-ASCII Unicode characters with their UTF-8 original forms
931 * for more compact display and legibility for local audiences.
933 * @todo handle punycode domains too
938 function wfExpandIRI( $url ) {
939 return preg_replace_callback(
940 '/((?:%[89A-F][0-9A-F])+)/i',
941 'wfExpandIRI_callback',
947 * Private callback for wfExpandIRI
948 * @param array $matches
951 function wfExpandIRI_callback( $matches ) {
952 return urldecode( $matches[1] );
956 * Make URL indexes, appropriate for the el_index field of externallinks.
961 function wfMakeUrlIndexes( $url ) {
962 $bits = wfParseUrl( $url );
964 // Reverse the labels in the hostname, convert to lower case
965 // For emails reverse domainpart only
966 if ( $bits['scheme'] == 'mailto' ) {
967 $mailparts = explode( '@', $bits['host'], 2 );
968 if ( count( $mailparts ) === 2 ) {
969 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
971 // No domain specified, don't mangle it
974 $reversedHost = $domainpart . '@' . $mailparts[0];
976 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
978 // Add an extra dot to the end
979 // Why? Is it in wrong place in mailto links?
980 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
981 $reversedHost .= '.';
983 // Reconstruct the pseudo-URL
984 $prot = $bits['scheme'];
985 $index = $prot . $bits['delimiter'] . $reversedHost;
986 // Leave out user and password. Add the port, path, query and fragment
987 if ( isset( $bits['port'] ) ) {
988 $index .= ':' . $bits['port'];
990 if ( isset( $bits['path'] ) ) {
991 $index .= $bits['path'];
995 if ( isset( $bits['query'] ) ) {
996 $index .= '?' . $bits['query'];
998 if ( isset( $bits['fragment'] ) ) {
999 $index .= '#' . $bits['fragment'];
1002 if ( $prot == '' ) {
1003 return array( "http:$index", "https:$index" );
1005 return array( $index );
1010 * Check whether a given URL has a domain that occurs in a given set of domains
1011 * @param string $url URL
1012 * @param array $domains Array of domains (strings)
1013 * @return bool True if the host part of $url ends in one of the strings in $domains
1015 function wfMatchesDomainList( $url, $domains ) {
1016 $bits = wfParseUrl( $url );
1017 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
1018 $host = '.' . $bits['host'];
1019 foreach ( (array)$domains as $domain ) {
1020 $domain = '.' . $domain;
1021 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1030 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
1031 * In normal operation this is a NOP.
1033 * Controlling globals:
1034 * $wgDebugLogFile - points to the log file
1035 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1036 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1038 * @since 1.25 support for additional context data
1040 * @param string $text
1041 * @param string|bool $dest Unused
1042 * @param array $context Additional logging context data
1044 function wfDebug( $text, $dest = 'all', array $context = array() ) {
1045 global $wgDebugRawPage, $wgDebugLogPrefix;
1046 global $wgDebugTimestamps, $wgRequestTime;
1048 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1052 $text = trim( $text );
1054 if ( $wgDebugTimestamps ) {
1055 $context['seconds_elapsed'] = sprintf(
1057 microtime( true ) - $wgRequestTime
1059 $context['memory_used'] = sprintf(
1061 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1065 if ( $wgDebugLogPrefix !== '' ) {
1066 $context['prefix'] = $wgDebugLogPrefix;
1069 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1070 $logger->debug( $text, $context );
1074 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1077 function wfIsDebugRawPage() {
1079 if ( $cache !== null ) {
1082 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1083 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1085 isset( $_SERVER['SCRIPT_NAME'] )
1086 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1097 * Send a line giving PHP memory usage.
1099 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1101 function wfDebugMem( $exact = false ) {
1102 $mem = memory_get_usage();
1104 $mem = floor( $mem / 1024 ) . ' KiB';
1108 wfDebug( "Memory usage: $mem\n" );
1112 * Send a line to a supplementary debug log file, if configured, or main debug
1115 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1116 * a string filename or an associative array mapping 'destination' to the
1117 * desired filename. The associative array may also contain a 'sample' key
1118 * with an integer value, specifying a sampling factor. Sampled log events
1119 * will be emitted with a 1 in N random chance.
1121 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1122 * @since 1.25 support for additional context data
1123 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1125 * @param string $logGroup
1126 * @param string $text
1127 * @param string|bool $dest Destination of the message:
1128 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1129 * - 'log': only to the log and not in HTML
1130 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1131 * discarded otherwise
1132 * For backward compatibility, it can also take a boolean:
1133 * - true: same as 'all'
1134 * - false: same as 'private'
1135 * @param array $context Additional logging context data
1137 function wfDebugLog(
1138 $logGroup, $text, $dest = 'all', array $context = array()
1140 // Turn $dest into a string if it's a boolean (for b/c)
1141 if ( $dest === true ) {
1143 } elseif ( $dest === false ) {
1147 $text = trim( $text );
1149 $logger = LoggerFactory
::getInstance( $logGroup );
1150 $context['private'] = ( $dest === 'private' );
1151 $logger->info( $text, $context );
1155 * Log for database errors
1157 * @since 1.25 support for additional context data
1159 * @param string $text Database error message.
1160 * @param array $context Additional logging context data
1162 function wfLogDBError( $text, array $context = array() ) {
1163 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1164 $logger->error( trim( $text ), $context );
1168 * Throws a warning that $function is deprecated
1170 * @param string $function
1171 * @param string|bool $version Version of MediaWiki that the function
1172 * was deprecated in (Added in 1.19).
1173 * @param string|bool $component Added in 1.19.
1174 * @param int $callerOffset How far up the call stack is the original
1175 * caller. 2 = function that called the function that called
1176 * wfDeprecated (Added in 1.20)
1180 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1181 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1185 * Send a warning either to the debug log or in a PHP error depending on
1186 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1188 * @param string $msg Message to send
1189 * @param int $callerOffset Number of items to go back in the backtrace to
1190 * find the correct caller (1 = function calling wfWarn, ...)
1191 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1192 * only used when $wgDevelopmentWarnings is true
1194 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1195 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1199 * Send a warning as a PHP error and the debug log. This is intended for logging
1200 * warnings in production. For logging development warnings, use WfWarn instead.
1202 * @param string $msg Message to send
1203 * @param int $callerOffset Number of items to go back in the backtrace to
1204 * find the correct caller (1 = function calling wfLogWarning, ...)
1205 * @param int $level PHP error level; defaults to E_USER_WARNING
1207 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1208 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1212 * Log to a file without getting "file size exceeded" signals.
1214 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1215 * send lines to the specified port, prefixed by the specified prefix and a space.
1216 * @since 1.25 support for additional context data
1218 * @param string $text
1219 * @param string $file Filename
1220 * @param array $context Additional logging context data
1221 * @throws MWException
1222 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1224 function wfErrorLog( $text, $file, array $context = array() ) {
1225 wfDeprecated( __METHOD__
, '1.25' );
1226 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1227 $context['destination'] = $file;
1228 $logger->info( trim( $text ), $context );
1234 function wfLogProfilingData() {
1235 global $wgDebugLogGroups, $wgDebugRawPage;
1237 $context = RequestContext
::getMain();
1238 $request = $context->getRequest();
1240 $profiler = Profiler
::instance();
1241 $profiler->setContext( $context );
1242 $profiler->logData();
1244 $config = $context->getConfig();
1245 if ( $config->get( 'StatsdServer' ) ) {
1247 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1248 $statsdHost = $statsdServer[0];
1249 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1250 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1251 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1252 $statsdClient->send( $context->getStats()->getBuffer() );
1253 } catch ( Exception
$ex ) {
1254 MWExceptionHandler
::logException( $ex );
1258 # Profiling must actually be enabled...
1259 if ( $profiler instanceof ProfilerStub
) {
1263 if ( isset( $wgDebugLogGroups['profileoutput'] )
1264 && $wgDebugLogGroups['profileoutput'] === false
1266 // Explicitly disabled
1269 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1273 $ctx = array( 'elapsed' => $request->getElapsedTime() );
1274 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1275 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1277 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1278 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1280 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1281 $ctx['from'] = $_SERVER['HTTP_FROM'];
1283 if ( isset( $ctx['forwarded_for'] ) ||
1284 isset( $ctx['client_ip'] ) ||
1285 isset( $ctx['from'] ) ) {
1286 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1289 // Don't load $wgUser at this late stage just for statistics purposes
1290 // @todo FIXME: We can detect some anons even if it is not loaded.
1291 // See User::getId()
1292 $user = $context->getUser();
1293 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1295 // Command line script uses a FauxRequest object which does not have
1296 // any knowledge about an URL and throw an exception instead.
1298 $ctx['url'] = urldecode( $request->getRequestURL() );
1299 } catch ( Exception
$ignored ) {
1303 $ctx['output'] = $profiler->getOutput();
1305 $log = LoggerFactory
::getInstance( 'profileoutput' );
1306 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1310 * Increment a statistics counter
1312 * @param string $key
1316 function wfIncrStats( $key, $count = 1 ) {
1317 $stats = RequestContext
::getMain()->getStats();
1318 $stats->updateCount( $key, $count );
1322 * Check whether the wiki is in read-only mode.
1326 function wfReadOnly() {
1327 return wfReadOnlyReason() !== false;
1331 * Check if the site is in read-only mode and return the message if so
1333 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1334 * for slave lag. This may result in DB_SLAVE connection being made.
1336 * @return string|bool String when in read-only mode; false otherwise
1338 function wfReadOnlyReason() {
1339 $readOnly = wfConfiguredReadOnlyReason();
1340 if ( $readOnly !== false ) {
1344 static $lbReadOnly = null;
1345 if ( $lbReadOnly === null ) {
1346 // Callers use this method to be aware that data presented to a user
1347 // may be very stale and thus allowing submissions can be problematic.
1348 $lbReadOnly = wfGetLB()->getReadOnlyReason();
1355 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1357 * @return string|bool String when in read-only mode; false otherwise
1360 function wfConfiguredReadOnlyReason() {
1361 global $wgReadOnly, $wgReadOnlyFile;
1363 if ( $wgReadOnly === null ) {
1364 // Set $wgReadOnly for faster access next time
1365 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1366 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1368 $wgReadOnly = false;
1376 * Return a Language object from $langcode
1378 * @param Language|string|bool $langcode Either:
1379 * - a Language object
1380 * - code of the language to get the message for, if it is
1381 * a valid code create a language for that language, if
1382 * it is a string but not a valid code then make a basic
1384 * - a boolean: if it's false then use the global object for
1385 * the current user's language (as a fallback for the old parameter
1386 * functionality), or if it is true then use global object
1387 * for the wiki's content language.
1390 function wfGetLangObj( $langcode = false ) {
1391 # Identify which language to get or create a language object for.
1392 # Using is_object here due to Stub objects.
1393 if ( is_object( $langcode ) ) {
1394 # Great, we already have the object (hopefully)!
1398 global $wgContLang, $wgLanguageCode;
1399 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1400 # $langcode is the language code of the wikis content language object.
1401 # or it is a boolean and value is true
1406 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1407 # $langcode is the language code of user language object.
1408 # or it was a boolean and value is false
1412 $validCodes = array_keys( Language
::fetchLanguageNames() );
1413 if ( in_array( $langcode, $validCodes ) ) {
1414 # $langcode corresponds to a valid language.
1415 return Language
::factory( $langcode );
1418 # $langcode is a string, but not a valid language code; use content language.
1419 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1424 * This is the function for getting translated interface messages.
1426 * @see Message class for documentation how to use them.
1427 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1429 * This function replaces all old wfMsg* functions.
1431 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1432 * @param mixed $params,... Normal message parameters
1437 * @see Message::__construct
1439 function wfMessage( $key /*...*/ ) {
1440 $params = func_get_args();
1441 array_shift( $params );
1442 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1443 $params = $params[0];
1445 return new Message( $key, $params );
1449 * This function accepts multiple message keys and returns a message instance
1450 * for the first message which is non-empty. If all messages are empty then an
1451 * instance of the first message key is returned.
1453 * @param string|string[] $keys,... Message keys
1458 * @see Message::newFallbackSequence
1460 function wfMessageFallback( /*...*/ ) {
1461 $args = func_get_args();
1462 return call_user_func_array( 'Message::newFallbackSequence', $args );
1466 * Get a message from anywhere, for the current user language.
1468 * Use wfMsgForContent() instead if the message should NOT
1469 * change depending on the user preferences.
1471 * @deprecated since 1.18
1473 * @param string $key Lookup key for the message, usually
1474 * defined in languages/Language.php
1476 * Parameters to the message, which can be used to insert variable text into
1477 * it, can be passed to this function in the following formats:
1478 * - One per argument, starting at the second parameter
1479 * - As an array in the second parameter
1480 * These are not shown in the function definition.
1484 function wfMsg( $key ) {
1485 wfDeprecated( __METHOD__
, '1.21' );
1487 $args = func_get_args();
1488 array_shift( $args );
1489 return wfMsgReal( $key, $args );
1493 * Same as above except doesn't transform the message
1495 * @deprecated since 1.18
1497 * @param string $key
1500 function wfMsgNoTrans( $key ) {
1501 wfDeprecated( __METHOD__
, '1.21' );
1503 $args = func_get_args();
1504 array_shift( $args );
1505 return wfMsgReal( $key, $args, true, false, false );
1509 * Get a message from anywhere, for the current global language
1510 * set with $wgLanguageCode.
1512 * Use this if the message should NOT change dependent on the
1513 * language set in the user's preferences. This is the case for
1514 * most text written into logs, as well as link targets (such as
1515 * the name of the copyright policy page). Link titles, on the
1516 * other hand, should be shown in the UI language.
1518 * Note that MediaWiki allows users to change the user interface
1519 * language in their preferences, but a single installation
1520 * typically only contains content in one language.
1522 * Be wary of this distinction: If you use wfMsg() where you should
1523 * use wfMsgForContent(), a user of the software may have to
1524 * customize potentially hundreds of messages in
1525 * order to, e.g., fix a link in every possible language.
1527 * @deprecated since 1.18
1529 * @param string $key Lookup key for the message, usually
1530 * defined in languages/Language.php
1533 function wfMsgForContent( $key ) {
1534 wfDeprecated( __METHOD__
, '1.21' );
1536 global $wgForceUIMsgAsContentMsg;
1537 $args = func_get_args();
1538 array_shift( $args );
1540 if ( is_array( $wgForceUIMsgAsContentMsg )
1541 && in_array( $key, $wgForceUIMsgAsContentMsg )
1543 $forcontent = false;
1545 return wfMsgReal( $key, $args, true, $forcontent );
1549 * Same as above except doesn't transform the message
1551 * @deprecated since 1.18
1553 * @param string $key
1556 function wfMsgForContentNoTrans( $key ) {
1557 wfDeprecated( __METHOD__
, '1.21' );
1559 global $wgForceUIMsgAsContentMsg;
1560 $args = func_get_args();
1561 array_shift( $args );
1563 if ( is_array( $wgForceUIMsgAsContentMsg )
1564 && in_array( $key, $wgForceUIMsgAsContentMsg )
1566 $forcontent = false;
1568 return wfMsgReal( $key, $args, true, $forcontent, false );
1572 * Really get a message
1574 * @deprecated since 1.18
1576 * @param string $key Key to get.
1577 * @param array $args
1578 * @param bool $useDB
1579 * @param string|bool $forContent Language code, or false for user lang, true for content lang.
1580 * @param bool $transform Whether or not to transform the message.
1581 * @return string The requested message.
1583 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1584 wfDeprecated( __METHOD__
, '1.21' );
1586 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1587 $message = wfMsgReplaceArgs( $message, $args );
1592 * Fetch a message string value, but don't replace any keys yet.
1594 * @deprecated since 1.18
1596 * @param string $key
1597 * @param bool $useDB
1598 * @param string|bool $langCode Code of the language to get the message for, or
1599 * behaves as a content language switch if it is a boolean.
1600 * @param bool $transform Whether to parse magic words, etc.
1603 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1604 wfDeprecated( __METHOD__
, '1.21' );
1606 Hooks
::run( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1608 $cache = MessageCache
::singleton();
1609 $message = $cache->get( $key, $useDB, $langCode );
1610 if ( $message === false ) {
1611 $message = '<' . htmlspecialchars( $key ) . '>';
1612 } elseif ( $transform ) {
1613 $message = $cache->transform( $message );
1619 * Replace message parameter keys on the given formatted output.
1621 * @param string $message
1622 * @param array $args
1626 function wfMsgReplaceArgs( $message, $args ) {
1627 # Fix windows line-endings
1628 # Some messages are split with explode("\n", $msg)
1629 $message = str_replace( "\r", '', $message );
1631 // Replace arguments
1632 if ( count( $args ) ) {
1633 if ( is_array( $args[0] ) ) {
1634 $args = array_values( $args[0] );
1636 $replacementKeys = array();
1637 foreach ( $args as $n => $param ) {
1638 $replacementKeys['$' . ( $n +
1 )] = $param;
1640 $message = strtr( $message, $replacementKeys );
1647 * Return an HTML-escaped version of a message.
1648 * Parameter replacements, if any, are done *after* the HTML-escaping,
1649 * so parameters may contain HTML (eg links or form controls). Be sure
1650 * to pre-escape them if you really do want plaintext, or just wrap
1651 * the whole thing in htmlspecialchars().
1653 * @deprecated since 1.18
1655 * @param string $key
1656 * @param string $args,... Parameters
1659 function wfMsgHtml( $key ) {
1660 wfDeprecated( __METHOD__
, '1.21' );
1662 $args = func_get_args();
1663 array_shift( $args );
1664 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1668 * Return an HTML version of message
1669 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1670 * so parameters may contain HTML (eg links or form controls). Be sure
1671 * to pre-escape them if you really do want plaintext, or just wrap
1672 * the whole thing in htmlspecialchars().
1674 * @deprecated since 1.18
1676 * @param string $key
1677 * @param string $args,... Parameters
1680 function wfMsgWikiHtml( $key ) {
1681 wfDeprecated( __METHOD__
, '1.21' );
1683 $args = func_get_args();
1684 array_shift( $args );
1685 return wfMsgReplaceArgs(
1686 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1687 /* can't be set to false */ true, /* interface */ true )->getText(),
1692 * Returns message in the requested format
1694 * @deprecated since 1.18
1696 * @param string $key Key of the message
1697 * @param array $options Processing rules.
1698 * Can take the following options:
1699 * parse: parses wikitext to HTML
1700 * parseinline: parses wikitext to HTML and removes the surrounding
1701 * p's added by parser or tidy
1702 * escape: filters message through htmlspecialchars
1703 * escapenoentities: same, but allows entity references like   through
1704 * replaceafter: parameters are substituted after parsing or escaping
1705 * parsemag: transform the message using magic phrases
1706 * content: fetch message for content language instead of interface
1707 * Also can accept a single associative argument, of the form 'language' => 'xx':
1708 * language: Language object or language code to fetch message for
1709 * (overridden by content).
1710 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1714 function wfMsgExt( $key, $options ) {
1715 wfDeprecated( __METHOD__
, '1.21' );
1717 $args = func_get_args();
1718 array_shift( $args );
1719 array_shift( $args );
1720 $options = (array)$options;
1721 $validOptions = array( 'parse', 'parseinline', 'escape', 'escapenoentities', 'replaceafter',
1722 'parsemag', 'content' );
1724 foreach ( $options as $arrayKey => $option ) {
1725 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1726 // An unknown index, neither numeric nor "language"
1727 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1728 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option, $validOptions ) ) {
1729 // A numeric index with unknown value
1730 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1734 if ( in_array( 'content', $options, true ) ) {
1737 $langCodeObj = null;
1738 } elseif ( array_key_exists( 'language', $options ) ) {
1739 $forContent = false;
1740 $langCode = wfGetLangObj( $options['language'] );
1741 $langCodeObj = $langCode;
1743 $forContent = false;
1745 $langCodeObj = null;
1748 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1750 if ( !in_array( 'replaceafter', $options, true ) ) {
1751 $string = wfMsgReplaceArgs( $string, $args );
1754 $messageCache = MessageCache
::singleton();
1755 $parseInline = in_array( 'parseinline', $options, true );
1756 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1757 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1758 if ( $string instanceof ParserOutput
) {
1759 $string = $string->getText();
1762 if ( $parseInline ) {
1763 $string = Parser
::stripOuterParagraph( $string );
1765 } elseif ( in_array( 'parsemag', $options, true ) ) {
1766 $string = $messageCache->transform( $string,
1767 !$forContent, $langCodeObj );
1770 if ( in_array( 'escape', $options, true ) ) {
1771 $string = htmlspecialchars( $string );
1772 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1773 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1776 if ( in_array( 'replaceafter', $options, true ) ) {
1777 $string = wfMsgReplaceArgs( $string, $args );
1784 * Since wfMsg() and co suck, they don't return false if the message key they
1785 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1786 * nonexistence of messages by checking the MessageCache::get() result directly.
1788 * @deprecated since 1.18. Use Message::isDisabled().
1790 * @param string $key The message key looked up
1791 * @return bool True if the message *doesn't* exist.
1793 function wfEmptyMsg( $key ) {
1794 wfDeprecated( __METHOD__
, '1.21' );
1796 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1800 * Fetch server name for use in error reporting etc.
1801 * Use real server name if available, so we know which machine
1802 * in a server farm generated the current page.
1806 function wfHostname() {
1808 if ( is_null( $host ) ) {
1810 # Hostname overriding
1811 global $wgOverrideHostname;
1812 if ( $wgOverrideHostname !== false ) {
1813 # Set static and skip any detection
1814 $host = $wgOverrideHostname;
1818 if ( function_exists( 'posix_uname' ) ) {
1819 // This function not present on Windows
1820 $uname = posix_uname();
1824 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1825 $host = $uname['nodename'];
1826 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1827 # Windows computer name
1828 $host = getenv( 'COMPUTERNAME' );
1830 # This may be a virtual server.
1831 $host = $_SERVER['SERVER_NAME'];
1838 * Returns a script tag that stores the amount of time it took MediaWiki to
1839 * handle the request in milliseconds as 'wgBackendResponseTime'.
1841 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1842 * hostname of the server handling the request.
1846 function wfReportTime() {
1847 global $wgRequestTime, $wgShowHostnames;
1849 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1850 $reportVars = array( 'wgBackendResponseTime' => $responseTime );
1851 if ( $wgShowHostnames ) {
1852 $reportVars['wgHostname'] = wfHostname();
1854 return Skin
::makeVariablesScript( $reportVars );
1858 * Safety wrapper for debug_backtrace().
1860 * Will return an empty array if debug_backtrace is disabled, otherwise
1861 * the output from debug_backtrace() (trimmed).
1863 * @param int $limit This parameter can be used to limit the number of stack frames returned
1865 * @return array Array of backtrace information
1867 function wfDebugBacktrace( $limit = 0 ) {
1868 static $disabled = null;
1870 if ( is_null( $disabled ) ) {
1871 $disabled = !function_exists( 'debug_backtrace' );
1873 wfDebug( "debug_backtrace() is disabled\n" );
1880 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1881 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1883 return array_slice( debug_backtrace(), 1 );
1888 * Get a debug backtrace as a string
1890 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1891 * Defaults to $wgCommandLineMode if unset.
1893 * @since 1.25 Supports $raw parameter.
1895 function wfBacktrace( $raw = null ) {
1896 global $wgCommandLineMode;
1898 if ( $raw === null ) {
1899 $raw = $wgCommandLineMode;
1903 $frameFormat = "%s line %s calls %s()\n";
1904 $traceFormat = "%s";
1906 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1907 $traceFormat = "<ul>\n%s</ul>\n";
1910 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1911 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1912 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1913 $call = $frame['function'];
1914 if ( !empty( $frame['class'] ) ) {
1915 $call = $frame['class'] . $frame['type'] . $call;
1917 return sprintf( $frameFormat, $file, $line, $call );
1918 }, wfDebugBacktrace() );
1920 return sprintf( $traceFormat, implode( '', $frames ) );
1924 * Get the name of the function which called this function
1925 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1926 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1927 * wfGetCaller( 3 ) is the parent of that.
1932 function wfGetCaller( $level = 2 ) {
1933 $backtrace = wfDebugBacktrace( $level +
1 );
1934 if ( isset( $backtrace[$level] ) ) {
1935 return wfFormatStackFrame( $backtrace[$level] );
1942 * Return a string consisting of callers in the stack. Useful sometimes
1943 * for profiling specific points.
1945 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1948 function wfGetAllCallers( $limit = 3 ) {
1949 $trace = array_reverse( wfDebugBacktrace() );
1950 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1951 $limit = count( $trace ) - 1;
1953 $trace = array_slice( $trace, -$limit - 1, $limit );
1954 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1958 * Return a string representation of frame
1960 * @param array $frame
1963 function wfFormatStackFrame( $frame ) {
1964 if ( !isset( $frame['function'] ) ) {
1965 return 'NO_FUNCTION_GIVEN';
1967 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1968 $frame['class'] . $frame['type'] . $frame['function'] :
1972 /* Some generic result counters, pulled out of SearchEngine */
1977 * @param int $offset
1981 function wfShowingResults( $offset, $limit ) {
1982 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1986 * Whether the client accept gzip encoding
1988 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1989 * Use this when considering to send a gzip-encoded response to the client.
1991 * @param bool $force Forces another check even if we already have a cached result.
1994 function wfClientAcceptsGzip( $force = false ) {
1995 static $result = null;
1996 if ( $result === null ||
$force ) {
1998 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1999 # @todo FIXME: We may want to blacklist some broken browsers
2002 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2003 $_SERVER['HTTP_ACCEPT_ENCODING'],
2007 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2011 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2020 * Obtain the offset and limit values from the request string;
2021 * used in special pages
2023 * @param int $deflimit Default limit if none supplied
2024 * @param string $optionname Name of a user preference to check against
2026 * @deprecated since 1.24, just call WebRequest::getLimitOffset() directly
2028 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2030 wfDeprecated( __METHOD__
, '1.24' );
2031 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2035 * Escapes the given text so that it may be output using addWikiText()
2036 * without any linking, formatting, etc. making its way through. This
2037 * is achieved by substituting certain characters with HTML entities.
2038 * As required by the callers, "<nowiki>" is not used.
2040 * @param string $text Text to be escaped
2043 function wfEscapeWikiText( $text ) {
2044 static $repl = null, $repl2 = null;
2045 if ( $repl === null ) {
2047 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2048 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2049 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2050 "\n#" => "\n#", "\r#" => "\r#",
2051 "\n*" => "\n*", "\r*" => "\r*",
2052 "\n:" => "\n:", "\r:" => "\r:",
2053 "\n " => "\n ", "\r " => "\r ",
2054 "\n\n" => "\n ", "\r\n" => " \n",
2055 "\n\r" => "\n ", "\r\r" => "\r ",
2056 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2057 "\n----" => "\n----", "\r----" => "\r----",
2058 '__' => '__', '://' => '://',
2061 // We have to catch everything "\s" matches in PCRE
2062 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2063 $repl["$magic "] = "$magic ";
2064 $repl["$magic\t"] = "$magic	";
2065 $repl["$magic\r"] = "$magic ";
2066 $repl["$magic\n"] = "$magic ";
2067 $repl["$magic\f"] = "$magic";
2070 // And handle protocols that don't use "://"
2071 global $wgUrlProtocols;
2073 foreach ( $wgUrlProtocols as $prot ) {
2074 if ( substr( $prot, -1 ) === ':' ) {
2075 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2078 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2080 $text = substr( strtr( "\n$text", $repl ), 1 );
2081 $text = preg_replace( $repl2, '$1:', $text );
2086 * Sets dest to source and returns the original value of dest
2087 * If source is NULL, it just returns the value, it doesn't set the variable
2088 * If force is true, it will set the value even if source is NULL
2090 * @param mixed $dest
2091 * @param mixed $source
2092 * @param bool $force
2095 function wfSetVar( &$dest, $source, $force = false ) {
2097 if ( !is_null( $source ) ||
$force ) {
2104 * As for wfSetVar except setting a bit
2108 * @param bool $state
2112 function wfSetBit( &$dest, $bit, $state = true ) {
2113 $temp = (bool)( $dest & $bit );
2114 if ( !is_null( $state ) ) {
2125 * A wrapper around the PHP function var_export().
2126 * Either print it or add it to the regular output ($wgOut).
2128 * @param mixed $var A PHP variable to dump.
2130 function wfVarDump( $var ) {
2132 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2133 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2136 $wgOut->addHTML( $s );
2141 * Provide a simple HTTP error.
2143 * @param int|string $code
2144 * @param string $label
2145 * @param string $desc
2147 function wfHttpError( $code, $label, $desc ) {
2149 HttpStatus
::header( $code );
2152 $wgOut->sendCacheControl();
2155 header( 'Content-type: text/html; charset=utf-8' );
2156 print '<!DOCTYPE html>' .
2157 '<html><head><title>' .
2158 htmlspecialchars( $label ) .
2159 '</title></head><body><h1>' .
2160 htmlspecialchars( $label ) .
2162 nl2br( htmlspecialchars( $desc ) ) .
2163 "</p></body></html>\n";
2167 * Clear away any user-level output buffers, discarding contents.
2169 * Suitable for 'starting afresh', for instance when streaming
2170 * relatively large amounts of data without buffering, or wanting to
2171 * output image files without ob_gzhandler's compression.
2173 * The optional $resetGzipEncoding parameter controls suppression of
2174 * the Content-Encoding header sent by ob_gzhandler; by default it
2175 * is left. See comments for wfClearOutputBuffers() for why it would
2178 * Note that some PHP configuration options may add output buffer
2179 * layers which cannot be removed; these are left in place.
2181 * @param bool $resetGzipEncoding
2183 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2184 if ( $resetGzipEncoding ) {
2185 // Suppress Content-Encoding and Content-Length
2186 // headers from 1.10+s wfOutputHandler
2187 global $wgDisableOutputCompression;
2188 $wgDisableOutputCompression = true;
2190 while ( $status = ob_get_status() ) {
2191 if ( isset( $status['flags'] ) ) {
2192 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
2193 $deleteable = ( $status['flags'] & $flags ) === $flags;
2194 } elseif ( isset( $status['del'] ) ) {
2195 $deleteable = $status['del'];
2197 // Guess that any PHP-internal setting can't be removed.
2198 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
2200 if ( !$deleteable ) {
2201 // Give up, and hope the result doesn't break
2205 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
2206 // Unit testing barrier to prevent this function from breaking PHPUnit.
2209 if ( !ob_end_clean() ) {
2210 // Could not remove output buffer handler; abort now
2211 // to avoid getting in some kind of infinite loop.
2214 if ( $resetGzipEncoding ) {
2215 if ( $status['name'] == 'ob_gzhandler' ) {
2216 // Reset the 'Content-Encoding' field set by this handler
2217 // so we can start fresh.
2218 header_remove( 'Content-Encoding' );
2226 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2228 * Clear away output buffers, but keep the Content-Encoding header
2229 * produced by ob_gzhandler, if any.
2231 * This should be used for HTTP 304 responses, where you need to
2232 * preserve the Content-Encoding header of the real result, but
2233 * also need to suppress the output of ob_gzhandler to keep to spec
2234 * and avoid breaking Firefox in rare cases where the headers and
2235 * body are broken over two packets.
2237 function wfClearOutputBuffers() {
2238 wfResetOutputBuffers( false );
2242 * Converts an Accept-* header into an array mapping string values to quality
2245 * @param string $accept
2246 * @param string $def Default
2247 * @return float[] Associative array of string => float pairs
2249 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2250 # No arg means accept anything (per HTTP spec)
2252 return array( $def => 1.0 );
2257 $parts = explode( ',', $accept );
2259 foreach ( $parts as $part ) {
2260 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2261 $values = explode( ';', trim( $part ) );
2263 if ( count( $values ) == 1 ) {
2264 $prefs[$values[0]] = 1.0;
2265 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2266 $prefs[$values[0]] = floatval( $match[1] );
2274 * Checks if a given MIME type matches any of the keys in the given
2275 * array. Basic wildcards are accepted in the array keys.
2277 * Returns the matching MIME type (or wildcard) if a match, otherwise
2280 * @param string $type
2281 * @param array $avail
2285 function mimeTypeMatch( $type, $avail ) {
2286 if ( array_key_exists( $type, $avail ) ) {
2289 $parts = explode( '/', $type );
2290 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2291 return $parts[0] . '/*';
2292 } elseif ( array_key_exists( '*/*', $avail ) ) {
2301 * Returns the 'best' match between a client's requested internet media types
2302 * and the server's list of available types. Each list should be an associative
2303 * array of type to preference (preference is a float between 0.0 and 1.0).
2304 * Wildcards in the types are acceptable.
2306 * @param array $cprefs Client's acceptable type list
2307 * @param array $sprefs Server's offered types
2310 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2311 * XXX: generalize to negotiate other stuff
2313 function wfNegotiateType( $cprefs, $sprefs ) {
2316 foreach ( array_keys( $sprefs ) as $type ) {
2317 $parts = explode( '/', $type );
2318 if ( $parts[1] != '*' ) {
2319 $ckey = mimeTypeMatch( $type, $cprefs );
2321 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2326 foreach ( array_keys( $cprefs ) as $type ) {
2327 $parts = explode( '/', $type );
2328 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2329 $skey = mimeTypeMatch( $type, $sprefs );
2331 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2339 foreach ( array_keys( $combine ) as $type ) {
2340 if ( $combine[$type] > $bestq ) {
2342 $bestq = $combine[$type];
2350 * Reference-counted warning suppression
2352 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
2355 function wfSuppressWarnings( $end = false ) {
2356 MediaWiki\
suppressWarnings( $end );
2360 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
2361 * Restore error level to previous value
2363 function wfRestoreWarnings() {
2364 MediaWiki\
suppressWarnings( true );
2367 # Autodetect, convert and provide timestamps of various types
2370 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2372 define( 'TS_UNIX', 0 );
2375 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2377 define( 'TS_MW', 1 );
2380 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2382 define( 'TS_DB', 2 );
2385 * RFC 2822 format, for E-mail and HTTP headers
2387 define( 'TS_RFC2822', 3 );
2390 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2392 * This is used by Special:Export
2394 define( 'TS_ISO_8601', 4 );
2397 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2399 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2400 * DateTime tag and page 36 for the DateTimeOriginal and
2401 * DateTimeDigitized tags.
2403 define( 'TS_EXIF', 5 );
2406 * Oracle format time.
2408 define( 'TS_ORACLE', 6 );
2411 * Postgres format time.
2413 define( 'TS_POSTGRES', 7 );
2416 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2418 define( 'TS_ISO_8601_BASIC', 9 );
2421 * Get a timestamp string in one of various formats
2423 * @param mixed $outputtype A timestamp in one of the supported formats, the
2424 * function will autodetect which format is supplied and act accordingly.
2425 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2426 * @return string|bool String / false The same date in the format specified in $outputtype or false
2428 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2430 $timestamp = new MWTimestamp( $ts );
2431 return $timestamp->getTimestamp( $outputtype );
2432 } catch ( TimestampException
$e ) {
2433 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2439 * Return a formatted timestamp, or null if input is null.
2440 * For dealing with nullable timestamp columns in the database.
2442 * @param int $outputtype
2446 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2447 if ( is_null( $ts ) ) {
2450 return wfTimestamp( $outputtype, $ts );
2455 * Convenience function; returns MediaWiki timestamp for the present time.
2459 function wfTimestampNow() {
2461 return wfTimestamp( TS_MW
, time() );
2465 * Check if the operating system is Windows
2467 * @return bool True if it's Windows, false otherwise.
2469 function wfIsWindows() {
2470 static $isWindows = null;
2471 if ( $isWindows === null ) {
2472 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2478 * Check if we are running under HHVM
2482 function wfIsHHVM() {
2483 return defined( 'HHVM_VERSION' );
2487 * Tries to get the system directory for temporary files. First
2488 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2489 * environment variables are then checked in sequence, and if none are
2490 * set try sys_get_temp_dir().
2492 * NOTE: When possible, use instead the tmpfile() function to create
2493 * temporary files to avoid race conditions on file creation, etc.
2497 function wfTempDir() {
2498 global $wgTmpDirectory;
2500 if ( $wgTmpDirectory !== false ) {
2501 return $wgTmpDirectory;
2504 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2506 foreach ( $tmpDir as $tmp ) {
2507 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2511 return sys_get_temp_dir();
2515 * Make directory, and make all parent directories if they don't exist
2517 * @param string $dir Full path to directory to create
2518 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2519 * @param string $caller Optional caller param for debugging.
2520 * @throws MWException
2523 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2524 global $wgDirectoryMode;
2526 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2527 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2530 if ( !is_null( $caller ) ) {
2531 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2534 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2538 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2540 if ( is_null( $mode ) ) {
2541 $mode = $wgDirectoryMode;
2544 // Turn off the normal warning, we're doing our own below
2545 MediaWiki\
suppressWarnings();
2546 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2547 MediaWiki\restoreWarnings
();
2550 // directory may have been created on another request since we last checked
2551 if ( is_dir( $dir ) ) {
2555 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2556 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2562 * Remove a directory and all its content.
2563 * Does not hide error.
2564 * @param string $dir
2566 function wfRecursiveRemoveDir( $dir ) {
2567 wfDebug( __FUNCTION__
. "( $dir )\n" );
2568 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2569 if ( is_dir( $dir ) ) {
2570 $objects = scandir( $dir );
2571 foreach ( $objects as $object ) {
2572 if ( $object != "." && $object != ".." ) {
2573 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2574 wfRecursiveRemoveDir( $dir . '/' . $object );
2576 unlink( $dir . '/' . $object );
2586 * @param int $nr The number to format
2587 * @param int $acc The number of digits after the decimal point, default 2
2588 * @param bool $round Whether or not to round the value, default true
2591 function wfPercent( $nr, $acc = 2, $round = true ) {
2592 $ret = sprintf( "%.${acc}f", $nr );
2593 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2597 * Safety wrapper around ini_get() for boolean settings.
2598 * The values returned from ini_get() are pre-normalized for settings
2599 * set via php.ini or php_flag/php_admin_flag... but *not*
2600 * for those set via php_value/php_admin_value.
2602 * It's fairly common for people to use php_value instead of php_flag,
2603 * which can leave you with an 'off' setting giving a false positive
2604 * for code that just takes the ini_get() return value as a boolean.
2606 * To make things extra interesting, setting via php_value accepts
2607 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2608 * Unrecognized values go false... again opposite PHP's own coercion
2609 * from string to bool.
2611 * Luckily, 'properly' set settings will always come back as '0' or '1',
2612 * so we only have to worry about them and the 'improper' settings.
2614 * I frickin' hate PHP... :P
2616 * @param string $setting
2619 function wfIniGetBool( $setting ) {
2620 $val = strtolower( ini_get( $setting ) );
2621 // 'on' and 'true' can't have whitespace around them, but '1' can.
2625 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2629 * Windows-compatible version of escapeshellarg()
2630 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2631 * function puts single quotes in regardless of OS.
2633 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2634 * earlier distro releases of PHP)
2636 * @param string ... strings to escape and glue together, or a single array of strings parameter
2639 function wfEscapeShellArg( /*...*/ ) {
2640 wfInitShellLocale();
2642 $args = func_get_args();
2643 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2644 // If only one argument has been passed, and that argument is an array,
2645 // treat it as a list of arguments
2646 $args = reset( $args );
2651 foreach ( $args as $arg ) {
2658 if ( wfIsWindows() ) {
2659 // Escaping for an MSVC-style command line parser and CMD.EXE
2660 // @codingStandardsIgnoreStart For long URLs
2662 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2663 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2666 // Double the backslashes before any double quotes. Escape the double quotes.
2667 // @codingStandardsIgnoreEnd
2668 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2671 foreach ( $tokens as $token ) {
2672 if ( $iteration %
2 == 1 ) {
2673 // Delimiter, a double quote preceded by zero or more slashes
2674 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2675 } elseif ( $iteration %
4 == 2 ) {
2676 // ^ in $token will be outside quotes, need to be escaped
2677 $arg .= str_replace( '^', '^^', $token );
2678 } else { // $iteration % 4 == 0
2679 // ^ in $token will appear inside double quotes, so leave as is
2684 // Double the backslashes before the end of the string, because
2685 // we will soon add a quote
2687 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2688 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2691 // Add surrounding quotes
2692 $retVal .= '"' . $arg . '"';
2694 $retVal .= escapeshellarg( $arg );
2701 * Check if wfShellExec() is effectively disabled via php.ini config
2703 * @return bool|string False or one of (safemode,disabled)
2706 function wfShellExecDisabled() {
2707 static $disabled = null;
2708 if ( is_null( $disabled ) ) {
2709 if ( wfIniGetBool( 'safe_mode' ) ) {
2710 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2711 $disabled = 'safemode';
2712 } elseif ( !function_exists( 'proc_open' ) ) {
2713 wfDebug( "proc_open() is disabled\n" );
2714 $disabled = 'disabled';
2723 * Execute a shell command, with time and memory limits mirrored from the PHP
2724 * configuration if supported.
2726 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2727 * or an array of unescaped arguments, in which case each value will be escaped
2728 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2729 * @param null|mixed &$retval Optional, will receive the program's exit code.
2730 * (non-zero is usually failure). If there is an error from
2731 * read, select, or proc_open(), this will be set to -1.
2732 * @param array $environ Optional environment variables which should be
2733 * added to the executed command environment.
2734 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2735 * this overwrites the global wgMaxShell* limits.
2736 * @param array $options Array of options:
2737 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2738 * including errors from limit.sh
2739 * - profileMethod: By default this function will profile based on the calling
2740 * method. Set this to a string for an alternative method to profile from
2742 * @return string Collected stdout as a string
2744 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2745 $limits = array(), $options = array()
2747 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2748 $wgMaxShellWallClockTime, $wgShellCgroup;
2750 $disabled = wfShellExecDisabled();
2753 return $disabled == 'safemode' ?
2754 'Unable to run external programs in safe mode.' :
2755 'Unable to run external programs, proc_open() is disabled.';
2758 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2759 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2761 wfInitShellLocale();
2764 foreach ( $environ as $k => $v ) {
2765 if ( wfIsWindows() ) {
2766 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2767 * appear in the environment variable, so we must use carat escaping as documented in
2768 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2769 * Note however that the quote isn't listed there, but is needed, and the parentheses
2770 * are listed there but doesn't appear to need it.
2772 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2774 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2775 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2777 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2780 if ( is_array( $cmd ) ) {
2781 $cmd = wfEscapeShellArg( $cmd );
2784 $cmd = $envcmd . $cmd;
2786 $useLogPipe = false;
2787 if ( is_executable( '/bin/bash' ) ) {
2788 $time = intval( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2789 if ( isset( $limits['walltime'] ) ) {
2790 $wallTime = intval( $limits['walltime'] );
2791 } elseif ( isset( $limits['time'] ) ) {
2794 $wallTime = intval( $wgMaxShellWallClockTime );
2796 $mem = intval( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2797 $filesize = intval( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2799 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2800 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2801 escapeshellarg( $cmd ) . ' ' .
2803 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2804 "MW_CPU_LIMIT=$time; " .
2805 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2806 "MW_MEM_LIMIT=$mem; " .
2807 "MW_FILE_SIZE_LIMIT=$filesize; " .
2808 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2809 "MW_USE_LOG_PIPE=yes"
2812 } elseif ( $includeStderr ) {
2815 } elseif ( $includeStderr ) {
2818 wfDebug( "wfShellExec: $cmd\n" );
2821 0 => array( 'file', 'php://stdin', 'r' ),
2822 1 => array( 'pipe', 'w' ),
2823 2 => array( 'file', 'php://stderr', 'w' ) );
2824 if ( $useLogPipe ) {
2825 $desc[3] = array( 'pipe', 'w' );
2828 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2829 $proc = proc_open( $cmd, $desc, $pipes );
2831 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2835 $outBuffer = $logBuffer = '';
2836 $emptyArray = array();
2840 /* According to the documentation, it is possible for stream_select()
2841 * to fail due to EINTR. I haven't managed to induce this in testing
2842 * despite sending various signals. If it did happen, the error
2843 * message would take the form:
2845 * stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2847 * where [4] is the value of the macro EINTR and "Interrupted system
2848 * call" is string which according to the Linux manual is "possibly"
2849 * localised according to LC_MESSAGES.
2851 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2852 $eintrMessage = "stream_select(): unable to select [$eintr]";
2854 // Build a table mapping resource IDs to pipe FDs to work around a
2855 // PHP 5.3 issue in which stream_select() does not preserve array keys
2856 // <https://bugs.php.net/bug.php?id=53427>.
2858 foreach ( $pipes as $fd => $pipe ) {
2859 $fds[(int)$pipe] = $fd;
2866 while ( $running === true ||
$numReadyPipes !== 0 ) {
2868 $status = proc_get_status( $proc );
2869 // If the process has terminated, switch to nonblocking selects
2870 // for getting any data still waiting to be read.
2871 if ( !$status['running'] ) {
2877 $readyPipes = $pipes;
2880 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2881 @trigger_error
( '' );
2882 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2883 if ( $numReadyPipes === false ) {
2884 // @codingStandardsIgnoreEnd
2885 $error = error_get_last();
2886 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2889 trigger_error( $error['message'], E_USER_WARNING
);
2890 $logMsg = $error['message'];
2894 foreach ( $readyPipes as $pipe ) {
2895 $block = fread( $pipe, 65536 );
2896 $fd = $fds[(int)$pipe];
2897 if ( $block === '' ) {
2899 fclose( $pipes[$fd] );
2900 unset( $pipes[$fd] );
2904 } elseif ( $block === false ) {
2906 $logMsg = "Error reading from pipe";
2908 } elseif ( $fd == 1 ) {
2910 $outBuffer .= $block;
2911 } elseif ( $fd == 3 ) {
2913 $logBuffer .= $block;
2914 if ( strpos( $block, "\n" ) !== false ) {
2915 $lines = explode( "\n", $logBuffer );
2916 $logBuffer = array_pop( $lines );
2917 foreach ( $lines as $line ) {
2918 wfDebugLog( 'exec', $line );
2925 foreach ( $pipes as $pipe ) {
2929 // Use the status previously collected if possible, since proc_get_status()
2930 // just calls waitpid() which will not return anything useful the second time.
2932 $status = proc_get_status( $proc );
2935 if ( $logMsg !== false ) {
2936 // Read/select error
2938 proc_close( $proc );
2939 } elseif ( $status['signaled'] ) {
2940 $logMsg = "Exited with signal {$status['termsig']}";
2941 $retval = 128 +
$status['termsig'];
2942 proc_close( $proc );
2944 if ( $status['running'] ) {
2945 $retval = proc_close( $proc );
2947 $retval = $status['exitcode'];
2948 proc_close( $proc );
2950 if ( $retval == 127 ) {
2951 $logMsg = "Possibly missing executable file";
2952 } elseif ( $retval >= 129 && $retval <= 192 ) {
2953 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2957 if ( $logMsg !== false ) {
2958 wfDebugLog( 'exec', "$logMsg: $cmd" );
2965 * Execute a shell command, returning both stdout and stderr. Convenience
2966 * function, as all the arguments to wfShellExec can become unwieldy.
2968 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2969 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2970 * or an array of unescaped arguments, in which case each value will be escaped
2971 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2972 * @param null|mixed &$retval Optional, will receive the program's exit code.
2973 * (non-zero is usually failure)
2974 * @param array $environ Optional environment variables which should be
2975 * added to the executed command environment.
2976 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2977 * this overwrites the global wgMaxShell* limits.
2978 * @return string Collected stdout and stderr as a string
2980 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2981 return wfShellExec( $cmd, $retval, $environ, $limits,
2982 array( 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ) );
2986 * Workaround for http://bugs.php.net/bug.php?id=45132
2987 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2989 function wfInitShellLocale() {
2990 static $done = false;
2995 global $wgShellLocale;
2996 if ( !wfIniGetBool( 'safe_mode' ) ) {
2997 putenv( "LC_CTYPE=$wgShellLocale" );
2998 setlocale( LC_CTYPE
, $wgShellLocale );
3003 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3004 * Note that $parameters should be a flat array and an option with an argument
3005 * should consist of two consecutive items in the array (do not use "--option value").
3007 * @param string $script MediaWiki cli script path
3008 * @param array $parameters Arguments and options to the script
3009 * @param array $options Associative array of options:
3010 * 'php': The path to the php executable
3011 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3014 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3016 // Give site config file a chance to run the script in a wrapper.
3017 // The caller may likely want to call wfBasename() on $script.
3018 Hooks
::run( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3019 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3020 if ( isset( $options['wrapper'] ) ) {
3021 $cmd[] = $options['wrapper'];
3024 // Escape each parameter for shell
3025 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
3029 * wfMerge attempts to merge differences between three texts.
3030 * Returns true for a clean merge and false for failure or a conflict.
3032 * @param string $old
3033 * @param string $mine
3034 * @param string $yours
3035 * @param string $result
3038 function wfMerge( $old, $mine, $yours, &$result ) {
3041 # This check may also protect against code injection in
3042 # case of broken installations.
3043 MediaWiki\
suppressWarnings();
3044 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3045 MediaWiki\restoreWarnings
();
3047 if ( !$haveDiff3 ) {
3048 wfDebug( "diff3 not found\n" );
3052 # Make temporary files
3054 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3055 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3056 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3058 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3059 # a newline character. To avoid this, we normalize the trailing whitespace before
3060 # creating the diff.
3062 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3063 fclose( $oldtextFile );
3064 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3065 fclose( $mytextFile );
3066 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3067 fclose( $yourtextFile );
3069 # Check for a conflict
3070 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
3071 $oldtextName, $yourtextName );
3072 $handle = popen( $cmd, 'r' );
3074 if ( fgets( $handle, 1024 ) ) {
3082 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
3083 $oldtextName, $yourtextName );
3084 $handle = popen( $cmd, 'r' );
3087 $data = fread( $handle, 8192 );
3088 if ( strlen( $data ) == 0 ) {
3094 unlink( $mytextName );
3095 unlink( $oldtextName );
3096 unlink( $yourtextName );
3098 if ( $result === '' && $old !== '' && !$conflict ) {
3099 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3106 * Returns unified plain-text diff of two texts.
3107 * "Useful" for machine processing of diffs.
3109 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
3111 * @param string $before The text before the changes.
3112 * @param string $after The text after the changes.
3113 * @param string $params Command-line options for the diff command.
3114 * @return string Unified diff of $before and $after
3116 function wfDiff( $before, $after, $params = '-u' ) {
3117 if ( $before == $after ) {
3122 MediaWiki\
suppressWarnings();
3123 $haveDiff = $wgDiff && file_exists( $wgDiff );
3124 MediaWiki\restoreWarnings
();
3126 # This check may also protect against code injection in
3127 # case of broken installations.
3129 wfDebug( "diff executable not found\n" );
3130 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3131 $format = new UnifiedDiffFormatter();
3132 return $format->format( $diffs );
3135 # Make temporary files
3137 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3138 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3140 fwrite( $oldtextFile, $before );
3141 fclose( $oldtextFile );
3142 fwrite( $newtextFile, $after );
3143 fclose( $newtextFile );
3145 // Get the diff of the two files
3146 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3148 $h = popen( $cmd, 'r' );
3150 unlink( $oldtextName );
3151 unlink( $newtextName );
3152 throw new Exception( __METHOD__
. '(): popen() failed' );
3158 $data = fread( $h, 8192 );
3159 if ( strlen( $data ) == 0 ) {
3167 unlink( $oldtextName );
3168 unlink( $newtextName );
3170 // Kill the --- and +++ lines. They're not useful.
3171 $diff_lines = explode( "\n", $diff );
3172 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
3173 unset( $diff_lines[0] );
3175 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
3176 unset( $diff_lines[1] );
3179 $diff = implode( "\n", $diff_lines );
3185 * This function works like "use VERSION" in Perl, the program will die with a
3186 * backtrace if the current version of PHP is less than the version provided
3188 * This is useful for extensions which due to their nature are not kept in sync
3189 * with releases, and might depend on other versions of PHP than the main code
3191 * Note: PHP might die due to parsing errors in some cases before it ever
3192 * manages to call this function, such is life
3194 * @see perldoc -f use
3196 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3197 * @throws MWException
3199 function wfUsePHP( $req_ver ) {
3200 $php_ver = PHP_VERSION
;
3202 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3203 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3208 * This function works like "use VERSION" in Perl except it checks the version
3209 * of MediaWiki, the program will die with a backtrace if the current version
3210 * of MediaWiki is less than the version provided.
3212 * This is useful for extensions which due to their nature are not kept in sync
3215 * Note: Due to the behavior of PHP's version_compare() which is used in this
3216 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3217 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3218 * targeted version number. For example if you wanted to allow any variation
3219 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3220 * not result in the same comparison due to the internal logic of
3221 * version_compare().
3223 * @see perldoc -f use
3225 * @deprecated since 1.26, use the "requires' property of extension.json
3226 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
3227 * @throws MWException
3229 function wfUseMW( $req_ver ) {
3232 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3233 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3238 * Return the final portion of a pathname.
3239 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3240 * http://bugs.php.net/bug.php?id=33898
3242 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3243 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3245 * @param string $path
3246 * @param string $suffix String to remove if present
3249 function wfBaseName( $path, $suffix = '' ) {
3250 if ( $suffix == '' ) {
3253 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3257 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3265 * Generate a relative path name to the given file.
3266 * May explode on non-matching case-insensitive paths,
3267 * funky symlinks, etc.
3269 * @param string $path Absolute destination path including target filename
3270 * @param string $from Absolute source path, directory only
3273 function wfRelativePath( $path, $from ) {
3274 // Normalize mixed input on Windows...
3275 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3276 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3278 // Trim trailing slashes -- fix for drive root
3279 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3280 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3282 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3283 $against = explode( DIRECTORY_SEPARATOR
, $from );
3285 if ( $pieces[0] !== $against[0] ) {
3286 // Non-matching Windows drive letters?
3287 // Return a full path.
3291 // Trim off common prefix
3292 while ( count( $pieces ) && count( $against )
3293 && $pieces[0] == $against[0] ) {
3294 array_shift( $pieces );
3295 array_shift( $against );
3298 // relative dots to bump us to the parent
3299 while ( count( $against ) ) {
3300 array_unshift( $pieces, '..' );
3301 array_shift( $against );
3304 array_push( $pieces, wfBaseName( $path ) );
3306 return implode( DIRECTORY_SEPARATOR
, $pieces );
3310 * Convert an arbitrarily-long digit string from one numeric base
3311 * to another, optionally zero-padding to a minimum column width.
3313 * Supports base 2 through 36; digit values 10-36 are represented
3314 * as lowercase letters a-z. Input is case-insensitive.
3316 * @deprecated 1.27 Use Wikimedia\base_convert() directly
3318 * @param string $input Input number
3319 * @param int $sourceBase Base of the input number
3320 * @param int $destBase Desired base of the output
3321 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3322 * @param bool $lowercase Whether to output in lowercase or uppercase
3323 * @param string $engine Either "gmp", "bcmath", or "php"
3324 * @return string|bool The output number as a string, or false on error
3326 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3327 $lowercase = true, $engine = 'auto'
3329 return Wikimedia\base_convert
( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
3333 * Check if there is sufficient entropy in php's built-in session generation
3335 * @return bool True = there is sufficient entropy
3337 function wfCheckEntropy() {
3339 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3340 ||
ini_get( 'session.entropy_file' )
3342 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3346 * Override session_id before session startup if php's built-in
3347 * session generation code is not secure.
3349 function wfFixSessionID() {
3350 // If the cookie or session id is already set we already have a session and should abort
3351 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3355 // PHP's built-in session entropy is enabled if:
3356 // - entropy_file is set or you're on Windows with php 5.3.3+
3357 // - AND entropy_length is > 0
3358 // We treat it as disabled if it doesn't have an entropy length of at least 32
3359 $entropyEnabled = wfCheckEntropy();
3361 // If built-in entropy is not enabled or not sufficient override PHP's
3362 // built in session id generation code
3363 if ( !$entropyEnabled ) {
3364 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3365 "overriding session id generation using our cryptrand source.\n" );
3366 session_id( MWCryptRand
::generateHex( 32 ) );
3371 * Reset the session_id
3375 function wfResetSessionID() {
3376 global $wgCookieSecure;
3377 $oldSessionId = session_id();
3378 $cookieParams = session_get_cookie_params();
3379 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3380 session_regenerate_id( false );
3384 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3387 $newSessionId = session_id();
3391 * Initialise php session
3393 * @param bool $sessionId
3395 function wfSetupSession( $sessionId = false ) {
3396 global $wgSessionsInObjectCache, $wgSessionHandler;
3397 global $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly;
3399 if ( $wgSessionsInObjectCache ) {
3400 ObjectCacheSessionHandler
::install();
3401 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3402 # Only set this if $wgSessionHandler isn't null and session.save_handler
3403 # hasn't already been set to the desired value (that causes errors)
3404 ini_set( 'session.save_handler', $wgSessionHandler );
3407 session_set_cookie_params(
3408 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly );
3409 session_cache_limiter( 'private, must-revalidate' );
3411 session_id( $sessionId );
3416 MediaWiki\
suppressWarnings();
3418 MediaWiki\restoreWarnings
();
3420 if ( $wgSessionsInObjectCache ) {
3421 ObjectCacheSessionHandler
::renewCurrentSession();
3426 * Get an object from the precompiled serialized directory
3428 * @param string $name
3429 * @return mixed The variable on success, false on failure
3431 function wfGetPrecompiledData( $name ) {
3434 $file = "$IP/serialized/$name";
3435 if ( file_exists( $file ) ) {
3436 $blob = file_get_contents( $file );
3438 return unserialize( $blob );
3445 * Make a cache key for the local wiki.
3447 * @param string $args,...
3450 function wfMemcKey( /*...*/ ) {
3451 return call_user_func_array(
3452 array( ObjectCache
::getLocalClusterInstance(), 'makeKey' ),
3458 * Make a cache key for a foreign DB.
3460 * Must match what wfMemcKey() would produce in context of the foreign wiki.
3463 * @param string $prefix
3464 * @param string $args,...
3467 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3468 $args = array_slice( func_get_args(), 2 );
3469 $keyspace = $prefix ?
"$db-$prefix" : $db;
3470 return call_user_func_array(
3471 array( ObjectCache
::getLocalClusterInstance(), 'makeKeyInternal' ),
3472 array( $keyspace, $args )
3477 * Make a cache key with database-agnostic prefix.
3479 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
3480 * instead. Must have a prefix as otherwise keys that use a database name
3481 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
3484 * @param string $args,...
3487 function wfGlobalCacheKey( /*...*/ ) {
3488 return call_user_func_array(
3489 array( ObjectCache
::getLocalClusterInstance(), 'makeGlobalKey' ),
3495 * Get an ASCII string identifying this wiki
3496 * This is used as a prefix in memcached keys
3500 function wfWikiID() {
3501 global $wgDBprefix, $wgDBname;
3502 if ( $wgDBprefix ) {
3503 return "$wgDBname-$wgDBprefix";
3510 * Split a wiki ID into DB name and table prefix
3512 * @param string $wiki
3516 function wfSplitWikiID( $wiki ) {
3517 $bits = explode( '-', $wiki, 2 );
3518 if ( count( $bits ) < 2 ) {
3525 * Get a Database object.
3527 * @param int $db Index of the connection to get. May be DB_MASTER for the
3528 * master (for write queries), DB_SLAVE for potentially lagged read
3529 * queries, or an integer >= 0 for a particular server.
3531 * @param string|string[] $groups Query groups. An array of group names that this query
3532 * belongs to. May contain a single string if the query is only
3535 * @param string|bool $wiki The wiki ID, or false for the current wiki
3537 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3538 * will always return the same object, unless the underlying connection or load
3539 * balancer is manually destroyed.
3541 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3542 * updater to ensure that a proper database is being updated.
3544 * @return DatabaseBase
3546 function wfGetDB( $db, $groups = array(), $wiki = false ) {
3547 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3551 * Get a load balancer object.
3553 * @param string|bool $wiki Wiki ID, or false for the current wiki
3554 * @return LoadBalancer
3556 function wfGetLB( $wiki = false ) {
3557 return wfGetLBFactory()->getMainLB( $wiki );
3561 * Get the load balancer factory object
3565 function wfGetLBFactory() {
3566 return LBFactory
::singleton();
3571 * Shortcut for RepoGroup::singleton()->findFile()
3573 * @param string $title String or Title object
3574 * @param array $options Associative array of options (see RepoGroup::findFile)
3575 * @return File|bool File, or false if the file does not exist
3577 function wfFindFile( $title, $options = array() ) {
3578 return RepoGroup
::singleton()->findFile( $title, $options );
3582 * Get an object referring to a locally registered file.
3583 * Returns a valid placeholder object if the file does not exist.
3585 * @param Title|string $title
3586 * @return LocalFile|null A File, or null if passed an invalid Title
3588 function wfLocalFile( $title ) {
3589 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3593 * Should low-performance queries be disabled?
3596 * @codeCoverageIgnore
3598 function wfQueriesMustScale() {
3599 global $wgMiserMode;
3601 ||
( SiteStats
::pages() > 100000
3602 && SiteStats
::edits() > 1000000
3603 && SiteStats
::users() > 10000 );
3607 * Get the path to a specified script file, respecting file
3608 * extensions; this is a wrapper around $wgScriptPath etc.
3609 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3611 * @param string $script Script filename, sans extension
3614 function wfScript( $script = 'index' ) {
3615 global $wgScriptPath, $wgScript, $wgLoadScript;
3616 if ( $script === 'index' ) {
3618 } elseif ( $script === 'load' ) {
3619 return $wgLoadScript;
3621 return "{$wgScriptPath}/{$script}.php";
3626 * Get the script URL.
3628 * @return string Script URL
3630 function wfGetScriptUrl() {
3631 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3632 /* as it was called, minus the query string.
3634 * Some sites use Apache rewrite rules to handle subdomains,
3635 * and have PHP set up in a weird way that causes PHP_SELF
3636 * to contain the rewritten URL instead of the one that the
3637 * outside world sees.
3639 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
3640 * provides containing the "before" URL.
3642 return $_SERVER['SCRIPT_NAME'];
3644 return $_SERVER['URL'];
3649 * Convenience function converts boolean values into "true"
3650 * or "false" (string) values
3652 * @param bool $value
3655 function wfBoolToStr( $value ) {
3656 return $value ?
'true' : 'false';
3660 * Get a platform-independent path to the null file, e.g. /dev/null
3664 function wfGetNull() {
3665 return wfIsWindows() ?
'NUL' : '/dev/null';
3669 * Waits for the slaves to catch up to the master position
3671 * Use this when updating very large numbers of rows, as in maintenance scripts,
3672 * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3674 * By default this waits on the main DB cluster of the current wiki.
3675 * If $cluster is set to "*" it will wait on all DB clusters, including
3676 * external ones. If the lag being waiting on is caused by the code that
3677 * does this check, it makes since to use $ifWritesSince, particularly if
3678 * cluster is "*", to avoid excess overhead.
3680 * Never call this function after a big DB write that is still in a transaction.
3681 * This only makes sense after the possible lag inducing changes were committed.
3683 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3684 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3685 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3686 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3687 * @return bool Success (able to connect and no timeouts reached)
3689 function wfWaitForSlaves(
3690 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3692 // B/C: first argument used to be "max seconds of lag"; ignore such values
3693 $ifWritesSince = ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null;
3695 if ( $timeout === null ) {
3696 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3699 // Figure out which clusters need to be checked
3700 /** @var LoadBalancer[] $lbs */
3702 if ( $cluster === '*' ) {
3703 wfGetLBFactory()->forEachLB( function ( LoadBalancer
$lb ) use ( &$lbs ) {
3706 } elseif ( $cluster !== false ) {
3707 $lbs[] = wfGetLBFactory()->getExternalLB( $cluster );
3709 $lbs[] = wfGetLB( $wiki );
3712 // Get all the master positions of applicable DBs right now.
3713 // This can be faster since waiting on one cluster reduces the
3714 // time needed to wait on the next clusters.
3715 $masterPositions = array_fill( 0, count( $lbs ), false );
3716 foreach ( $lbs as $i => $lb ) {
3717 if ( $lb->getServerCount() <= 1 ) {
3718 // Bug 27975 - Don't try to wait for slaves if there are none
3719 // Prevents permission error when getting master position
3721 } elseif ( $ifWritesSince && $lb->lastMasterChangeTimestamp() < $ifWritesSince ) {
3722 continue; // no writes since the last wait
3724 $masterPositions[$i] = $lb->getMasterPos();
3728 foreach ( $lbs as $i => $lb ) {
3729 if ( $masterPositions[$i] ) {
3730 // The DBMS may not support getMasterPos() or the whole
3731 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3732 $ok = $lb->waitForAll( $masterPositions[$i], $timeout ) && $ok;
3740 * Count down from $seconds to zero on the terminal, with a one-second pause
3741 * between showing each number. For use in command-line scripts.
3743 * @codeCoverageIgnore
3744 * @param int $seconds
3746 function wfCountDown( $seconds ) {
3747 for ( $i = $seconds; $i >= 0; $i-- ) {
3748 if ( $i != $seconds ) {
3749 echo str_repeat( "\x08", strlen( $i +
1 ) );
3761 * Replace all invalid characters with -
3762 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3763 * By default, $wgIllegalFileChars = ':'
3765 * @param string $name Filename to process
3768 function wfStripIllegalFilenameChars( $name ) {
3769 global $wgIllegalFileChars;
3770 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3771 $name = wfBaseName( $name );
3772 $name = preg_replace(
3773 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3781 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3783 * @return int Resulting value of the memory limit.
3785 function wfMemoryLimit() {
3786 global $wgMemoryLimit;
3787 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3788 if ( $memlimit != -1 ) {
3789 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3790 if ( $conflimit == -1 ) {
3791 wfDebug( "Removing PHP's memory limit\n" );
3792 MediaWiki\
suppressWarnings();
3793 ini_set( 'memory_limit', $conflimit );
3794 MediaWiki\restoreWarnings
();
3796 } elseif ( $conflimit > $memlimit ) {
3797 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3798 MediaWiki\
suppressWarnings();
3799 ini_set( 'memory_limit', $conflimit );
3800 MediaWiki\restoreWarnings
();
3808 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3810 * @return int Prior time limit
3813 function wfTransactionalTimeLimit() {
3814 global $wgTransactionalTimeLimit;
3816 $timeLimit = ini_get( 'max_execution_time' );
3817 // Note that CLI scripts use 0
3818 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3819 set_time_limit( $wgTransactionalTimeLimit );
3822 ignore_user_abort( true ); // ignore client disconnects
3828 * Converts shorthand byte notation to integer form
3830 * @param string $string
3831 * @param int $default Returned if $string is empty
3834 function wfShorthandToInteger( $string = '', $default = -1 ) {
3835 $string = trim( $string );
3836 if ( $string === '' ) {
3839 $last = $string[strlen( $string ) - 1];
3840 $val = intval( $string );
3845 // break intentionally missing
3849 // break intentionally missing
3859 * Get the normalised IETF language tag
3860 * See unit test for examples.
3862 * @param string $code The language code.
3863 * @return string The language code which complying with BCP 47 standards.
3865 function wfBCP47( $code ) {
3866 $codeSegment = explode( '-', $code );
3868 foreach ( $codeSegment as $segNo => $seg ) {
3869 // when previous segment is x, it is a private segment and should be lc
3870 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3871 $codeBCP[$segNo] = strtolower( $seg );
3872 // ISO 3166 country code
3873 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3874 $codeBCP[$segNo] = strtoupper( $seg );
3875 // ISO 15924 script code
3876 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3877 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3878 // Use lowercase for other cases
3880 $codeBCP[$segNo] = strtolower( $seg );
3883 $langCode = implode( '-', $codeBCP );
3888 * Get a specific cache object.
3890 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3893 function wfGetCache( $cacheType ) {
3894 return ObjectCache
::getInstance( $cacheType );
3898 * Get the main cache object
3902 function wfGetMainCache() {
3903 global $wgMainCacheType;
3904 return ObjectCache
::getInstance( $wgMainCacheType );
3908 * Get the cache object used by the message cache
3912 function wfGetMessageCacheStorage() {
3913 global $wgMessageCacheType;
3914 return ObjectCache
::getInstance( $wgMessageCacheType );
3918 * Get the cache object used by the parser cache
3922 function wfGetParserCacheStorage() {
3923 global $wgParserCacheType;
3924 return ObjectCache
::getInstance( $wgParserCacheType );
3928 * Call hook functions defined in $wgHooks
3930 * @param string $event Event name
3931 * @param array $args Parameters passed to hook functions
3932 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3934 * @return bool True if no handler aborted the hook
3935 * @deprecated 1.25 - use Hooks::run
3937 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
3938 return Hooks
::run( $event, $args, $deprecatedVersion );
3942 * Wrapper around php's unpack.
3944 * @param string $format The format string (See php's docs)
3945 * @param string $data A binary string of binary data
3946 * @param int|bool $length The minimum length of $data or false. This is to
3947 * prevent reading beyond the end of $data. false to disable the check.
3949 * Also be careful when using this function to read unsigned 32 bit integer
3950 * because php might make it negative.
3952 * @throws MWException If $data not long enough, or if unpack fails
3953 * @return array Associative array of the extracted data
3955 function wfUnpack( $format, $data, $length = false ) {
3956 if ( $length !== false ) {
3957 $realLen = strlen( $data );
3958 if ( $realLen < $length ) {
3959 throw new MWException( "Tried to use wfUnpack on a "
3960 . "string of length $realLen, but needed one "
3961 . "of at least length $length."
3966 MediaWiki\
suppressWarnings();
3967 $result = unpack( $format, $data );
3968 MediaWiki\restoreWarnings
();
3970 if ( $result === false ) {
3971 // If it cannot extract the packed data.
3972 throw new MWException( "unpack could not unpack binary data" );
3978 * Determine if an image exists on the 'bad image list'.
3980 * The format of MediaWiki:Bad_image_list is as follows:
3981 * * Only list items (lines starting with "*") are considered
3982 * * The first link on a line must be a link to a bad image
3983 * * Any subsequent links on the same line are considered to be exceptions,
3984 * i.e. articles where the image may occur inline.
3986 * @param string $name The image name to check
3987 * @param Title|bool $contextTitle The page on which the image occurs, if known
3988 * @param string $blacklist Wikitext of a file blacklist
3991 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3992 # Handle redirects; callers almost always hit wfFindFile() anyway,
3993 # so just use that method because it has a fast process cache.
3994 $file = wfFindFile( $name ); // get the final name
3995 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3997 # Run the extension hook
3999 if ( !Hooks
::run( 'BadImage', array( $name, &$bad ) ) ) {
4003 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
4004 $key = wfMemcKey( 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist ) );
4005 $badImages = $cache->get( $key );
4007 if ( $badImages === false ) { // cache miss
4008 if ( $blacklist === null ) {
4009 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4011 # Build the list now
4012 $badImages = array();
4013 $lines = explode( "\n", $blacklist );
4014 foreach ( $lines as $line ) {
4016 if ( substr( $line, 0, 1 ) !== '*' ) {
4022 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4026 $exceptions = array();
4027 $imageDBkey = false;
4028 foreach ( $m[1] as $i => $titleText ) {
4029 $title = Title
::newFromText( $titleText );
4030 if ( !is_null( $title ) ) {
4032 $imageDBkey = $title->getDBkey();
4034 $exceptions[$title->getPrefixedDBkey()] = true;
4039 if ( $imageDBkey !== false ) {
4040 $badImages[$imageDBkey] = $exceptions;
4043 $cache->set( $key, $badImages, 60 );
4046 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4047 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4053 * Determine whether the client at a given source IP is likely to be able to
4054 * access the wiki via HTTPS.
4056 * @param string $ip The IPv4/6 address in the normal human-readable form
4059 function wfCanIPUseHTTPS( $ip ) {
4061 Hooks
::run( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4066 * Determine input string is represents as infinity
4068 * @param string $str The string to determine
4072 function wfIsInfinity( $str ) {
4073 $infinityValues = array( 'infinite', 'indefinite', 'infinity', 'never' );
4074 return in_array( $str, $infinityValues );
4078 * Returns true if these thumbnail parameters match one that MediaWiki
4079 * requests from file description pages and/or parser output.
4081 * $params is considered non-standard if they involve a non-standard
4082 * width or any non-default parameters aside from width and page number.
4083 * The number of possible files with standard parameters is far less than
4084 * that of all combinations; rate-limiting for them can thus be more generious.
4087 * @param array $params
4089 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
4091 function wfThumbIsStandard( File
$file, array $params ) {
4092 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
4094 $multipliers = array( 1 );
4095 if ( $wgResponsiveImages ) {
4096 // These available sizes are hardcoded currently elsewhere in MediaWiki.
4097 // @see Linker::processResponsiveImages
4098 $multipliers[] = 1.5;
4102 $handler = $file->getHandler();
4103 if ( !$handler ||
!isset( $params['width'] ) ) {
4107 $basicParams = array();
4108 if ( isset( $params['page'] ) ) {
4109 $basicParams['page'] = $params['page'];
4112 $thumbLimits = array();
4113 $imageLimits = array();
4114 // Expand limits to account for multipliers
4115 foreach ( $multipliers as $multiplier ) {
4116 $thumbLimits = array_merge( $thumbLimits, array_map(
4117 function ( $width ) use ( $multiplier ) {
4118 return round( $width * $multiplier );
4121 $imageLimits = array_merge( $imageLimits, array_map(
4122 function ( $pair ) use ( $multiplier ) {
4124 round( $pair[0] * $multiplier ),
4125 round( $pair[1] * $multiplier ),
4131 // Check if the width matches one of $wgThumbLimits
4132 if ( in_array( $params['width'], $thumbLimits ) ) {
4133 $normalParams = $basicParams +
array( 'width' => $params['width'] );
4134 // Append any default values to the map (e.g. "lossy", "lossless", ...)
4135 $handler->normaliseParams( $file, $normalParams );
4137 // If not, then check if the width matchs one of $wgImageLimits
4139 foreach ( $imageLimits as $pair ) {
4140 $normalParams = $basicParams +
array( 'width' => $pair[0], 'height' => $pair[1] );
4141 // Decide whether the thumbnail should be scaled on width or height.
4142 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
4143 $handler->normaliseParams( $file, $normalParams );
4144 // Check if this standard thumbnail size maps to the given width
4145 if ( $normalParams['width'] == $params['width'] ) {
4151 return false; // not standard for description pages
4155 // Check that the given values for non-page, non-width, params are just defaults
4156 foreach ( $params as $key => $value ) {
4157 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
4166 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
4168 * Values that exist in both values will be combined with += (all values of the array
4169 * of $newValues will be added to the values of the array of $baseArray, while values,
4170 * that exists in both, the value of $baseArray will be used).
4172 * @param array $baseArray The array where you want to add the values of $newValues to
4173 * @param array $newValues An array with new values
4174 * @return array The combined array
4177 function wfArrayPlus2d( array $baseArray, array $newValues ) {
4178 // First merge items that are in both arrays
4179 foreach ( $baseArray as $name => &$groupVal ) {
4180 if ( isset( $newValues[$name] ) ) {
4181 $groupVal +
= $newValues[$name];
4184 // Now add items that didn't exist yet
4185 $baseArray +
= $newValues;